//--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
// Copyright 2012 Microsoft Corporation. All Rights Reserved
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.   
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
//--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

namespace Preflight.Verifications
{
    using System;
    using System.Collections.Generic;
    using System.Net;

    /// <summary>
    /// Describes web get verification
    /// </summary>
    public class WebGetVerificationDescription : VerificationDescription
    {
        /// <summary>
        /// Gets or Sets function to retreive target url for the Get request
        /// </summary>
        public Func<string> GetUrl
        {
            get;
            set;
        }

        /// <summary>
        /// (Optional) enables making changes to the request prior to verification
        /// </summary>
        public Action<HttpWebRequest> OnBeforeRequestSend
        {
            get;
            set;
        }

        /// <summary>
        /// (Optional) By default the status code indicating success is 200. This enables overriding that default and setting more than one status
        /// </summary>
        public IEnumerable<HttpStatusCode> AcceptableStatusCodes
        {
            get;
            set;
        }

        protected override void ValidateState()
        {
            if (this.GetUrl == null)
            {
                throw new MissingDescriptionValueException("GetUrl");
            }
        }
    }
}
